home *** CD-ROM | disk | FTP | other *** search
/ Belgian Amiga Club - ADF Collection / BS1 part 40.zip / BS1 part 40 / Doc_disk3.adf / BROWSERdoc < prev    next >
Text File  |  1980-08-15  |  12KB  |  309 lines
  1. *************************************************************************
  2. EDITORS NOTE: Due to space limitations, the program "bgbrowser" that is
  3. mentioned in the documentation is not included on this disk.  This version
  4. was designed to eliminate certain problems that may occur in running
  5. the program from the CLI.  If you run into any problems, DON'T COMPLAIN
  6. TO THE AUTHOR, at least not until you've obtained the "bgbrowser" program
  7. from him.  An excellent way to do this to send the contribution that he
  8. requests.
  9. **************************************************************************
  10.  
  11. Browser -- a programmer's "Workbench".
  12.  
  13. Introduction
  14.  
  15.     The Amiga "Workbench" has some serious deficiencies as a working
  16. environment. The most important one is that it doesn't let you operate
  17. on just any file (this is rumored to be fixed in 1.4, by the way), but
  18. there are others. It's designed to be easy to learn and use, but it just
  19. isn't very powerful.
  20.  
  21. This program is an attempt to deal with some of these problems. It is
  22. not a complete replacement for Workbench, nor is it intended to be. There
  23. is no attempt to support icons, and there are no disk-oriented functions
  24. (formatting, copying, etc...).
  25.  
  26.     What Browser does allow you to do, easily and conveniently, is to
  27. move, copy, rename, and delete files and directories. It will also let you
  28. execute either Workbench or CLI programs, either directly by double-
  29. clicking them or by selecting them from a menu. By combining these you can
  30. set up a complete operating environment that will, to a large extent,
  31. replace both Workbench and the CLI.
  32.  
  33.     Browser presents you with a set of windows, representing directories,
  34. with all the files and directories within each listed in alphabetical
  35. order. Directories, displayed in color 2 (red/orange), are listed first,
  36. followed by the files. Selected files are displayed in inverse video.
  37.  
  38. Selecting Files
  39.  
  40.     You can select individual files three ways. First, just click on
  41. a file name. This will select that file and deselect all others. If you
  42. hold down the shift key when you click on the file, it will be selected
  43. without deselecting other files. This way you can build a list of files
  44. to operate on. So far this is just like Workbench, but if you click a
  45. selected file while holding down the shift key, it will be deselected
  46. without affecting other selected files. This lets you take back mistakes.
  47.  
  48.     Finally, you can use the menu items "Sel All" and "Sel Match" to
  49. select a group of files at once. "Sel All" will select all files in the
  50. active window. "Sel Match" will allow you to enter a pattern and then
  51. select only files matching that pattern in the active window. These
  52. normally act as toggles... if you have any selected files in the active
  53. window they will be deselected if they match.
  54.  
  55. Actions
  56.  
  57.     There are, again, three ways to manipulate selected files. First,
  58. you can drag a file or selected files to another window by holding down the
  59. left mouse button while you move the mouse. When you release the button,
  60. Browser will attempt to move the files to the location you indicate. This
  61. is just like the Workbench.
  62.  
  63.     Secondly, double-clicking a file will open it. If it's a directory,
  64. it will be opened and files in it will be displayed. If it's a program
  65. with an accompanying '.info' file, it will be launched as a Workbench task.
  66. This will also work with Projects, if the accompanying .info file specifies
  67. a tool. Finally, Browser will ask you if you want to launch it as a CLI
  68. program.
  69.  
  70.     Any other files selected will be passed to the new program, either
  71. on the CLI command line or in the Workbench Args structure. This is the
  72. normal Workbench shift-double-click method.
  73.  
  74.     Third, you can select a menu item.
  75.  
  76. Menus
  77.  
  78.     There are two main Browser menus. The first, "Browser", relates to
  79. the browser environment itself. The second, "Actions", relates to the files
  80. and directories displayed in Browser's windows. Menu items act either on
  81. selected files or on the currently active window. There are additional
  82. menus (called Tools Menus) that can be set up by the user.
  83.  
  84. Browser Menu
  85.  
  86.     Open
  87.  
  88.         This entry is equivalent to double-clicking the selected
  89.     file. It is included for consistency with Workbench. Strictly
  90.     speaking it should be in the Actions menu, but it seems to fit
  91.     here better.
  92.  
  93.     Close
  94.  
  95.         This entry is equivalent to clicking the active window's
  96.     close gadget.  Again, it's included for consistency with the
  97.     Workbench.
  98.  
  99.     Rescan
  100.  
  101.         This entry requests Browser to re-scan the directory displayed
  102.     in the active window. This is equivalent to, but a lot more convenient
  103.     than, closing and re-opening the window. I suppose I could poll the
  104.     disk for these, but if you use floppies much this becomes slightly
  105.     inconvenient.
  106.  
  107.     File Size
  108.  
  109.         When this is selected it toggles a bit associated with the
  110.     active window that indicated whether the size of each file should be
  111.     displayed alongside the name. In a future version this will be
  112.     expanded to include a full 'list'-style listing.
  113.  
  114.     Sel All
  115.  
  116.         This selects all files in the active window. Actually, it
  117.     toggles the selection of each file. Currently selected files will
  118.     be deselected.
  119.  
  120.     Sel Match...
  121.  
  122.         This is the same as Sel All, except that a pattern may be
  123.     provided to further restrict the selection.
  124.  
  125.     Options
  126.  
  127.         This allows you to modify the global behaviour of Browser
  128.     to some extent:
  129.  
  130.         X Toggle Selections
  131.  
  132.             This affects whether a selection through the menu,
  133.         or a shift-click, will deselect an already selected file.
  134.  
  135.         X Move files into subdirectories
  136.  
  137.             This effects whether you can move files into a
  138.         subdirectory by dragging them to it and releasing the mouse
  139.         button when the mouse is over the directory's name. If this
  140.         is not set you have to open the directory first.
  141.  
  142.         X Ask before moving into subdirectories
  143.  
  144.             If you permit files to be moved into subdirectories,
  145.         this determines if Browser will prompt you beforehand.
  146.  
  147.     Quit
  148.  
  149.         This selection closes all windows and terminates Browser.
  150.  
  151. Actions Menu
  152.  
  153.     The entries in this menu act on files rather than changing the state
  154. of Browser.
  155.  
  156.     WB Tool
  157.  
  158.         The currently selected file (singular) is entered into the
  159.     Tools menu as a workbench tool.
  160.  
  161.     CLI Tool...
  162.  
  163.         The currently selected file (singular) is entered into the
  164.     Tools menu as a CLI tool. Browser will pop up a requestor and allow
  165.     you to add additional arguments.
  166.  
  167.     Rename...
  168.  
  169.         The currently selected file (singular) is renamed. Browser
  170.     will pop up a requestor and allow you to enter the new name.
  171.  
  172.     Duplicate...
  173.  
  174.         The currently selected file (singular) is duplicated. Browser
  175.     will pop up a requestor and allow you to edit the new name (generated
  176.     by BumpRevision: "file" becomes "copy of file", and so on).
  177.  
  178.     Make Dir...
  179.  
  180.         Creates a new directory in the currently active window.
  181.     Browser will pop up a requestor and allow you to specify the name of
  182.     the new directory.
  183.  
  184.     Delete
  185.  
  186.         Deletes all selected files. This will only delete directories
  187.     if they happen to be empty.
  188.  
  189.     Delete All
  190.  
  191.         Deletes all selected files AND directories, recursively.
  192.  
  193. Tools Menus
  194.  
  195.     These menus (starting with Tools) are initially empty. They are filled
  196. in by selecting "Add * Tool" or from the file "s:browser.inittab". When you
  197. select an entry in these menus they're run (either as workbench or CLI
  198. programs) with all selected files being passed to the program. If you have
  199. a choice, you should make a program run under the Workbench... it's MUCH
  200. more reliable.
  201.  
  202. Environment
  203.  
  204.     Browser can itself be run from either the Workbench or the CLI. There
  205. are two separate versions of Browser on the distribution disk. The first,
  206. "browser", is a normal CLI/Workbench program. The second, "bgbrowser", is
  207. basically the same as "browser", but contains some extra code that
  208. automatically detaches it from your CLI.
  209.  
  210.     Browser uses a file, "s:browser.inittab", to pre-load the command
  211. menus. Each line in the file is a separate menu item, made up of 5 fields
  212. separated by semicolons:
  213.  
  214.     name;environment;command;stack;window
  215.  
  216.     The first field is the name that is to appear in the menu. This
  217. name can be preceded by the name of the menu to insert it in followed by
  218. a period. If the menu name is left off, the "Tools" menu will be used.
  219. For example, "Applications.Terminal Emulator" will create a menu entry
  220. for "Terminal Emulator" and install it in the "Applications" menu. If the
  221. menu doesn't already exist, it will be created.
  222.  
  223.     The two environments currently supported are the CLI and the
  224. Workbench. Project files (such as AmigaBasic programs) aren't supported
  225. through the menu system at this time, though they may be at a later date.
  226. They do work just fine when you double-click them.
  227.  
  228.     If our terminal emulator was to be run as a Workbench program, then
  229. this field should contain "Workbench". If it can't run under the Workbench,
  230. then it should contain "CLI". It is better, if possible, to run programs
  231. under the Workbench. It's a cleaner environment, and you don't get extra
  232. windows cluttering up your display.
  233.  
  234.     The next field is the name of the command. This should contain the
  235. full path name to the program. If the command is a CLI command, additional
  236. arguments can be included at this point. The names of any files highlighted
  237. when this menu is selected will be added to the end. If the command is
  238. a Workbench command, this should just be the program name. Highlighted
  239. files will be passed to the program in the Workbench Args structure.
  240.  
  241.     The next field is the stack size. It may be left off, and will
  242. default to 8K.
  243.  
  244.     The last field is the window. For a CLI command, this is the
  245. window that will be opened to run the CLI in. For a Workbench command,
  246. this is the ToolWindow that will be passed to it. If it's left off a
  247. default will be used.
  248.  
  249.     Applications.Terminal Emulator;Workbench;sys:system/Termulator
  250.  
  251. Limitations:
  252.  
  253.     The CLI capability occasionally leaves you in an interactive CLI
  254. after you exit the program. This is caused by using one of the BREAK keys
  255. while you're in the program. I had to leave this in to get finicky CLI
  256. programs, such as Manx 'Z' editor, to work properly.
  257.  
  258.     If you're copying a file to disk and you get a disk error,
  259. occasionally browser will appear to ignore disk errors and keep on trying
  260. to write. Actually, Browser handles all disk errors that get reported to
  261. it. For some reason AmigaDOS doesn't report errors promptly. I suspect
  262. this is related to requesting writes larger than a disk buffer, but I
  263. don't plan on having Browser do anything about this in the near future.
  264.  
  265.     Browser seems to run just fine with only the standard 4K stack. The
  266. minimum environment you need to run browser is:
  267.  
  268.      libs (dir)
  269.        icon.library
  270.  
  271. If you also want to run CLI programs, you also need:
  272.  
  273.      c (dir)
  274.        cd                               EndCLI
  275.        Failat                           NewCLI
  276.        Run                              Stack
  277.      l (dir)
  278.        Ram-Handler
  279.  
  280. These are needed to run the little scripts Browser builds in RAM: when you
  281. run a CLI program.
  282.  
  283. Author:
  284.  
  285.     Peter da Silva
  286.  
  287.     U.S.Mail:
  288.         1620 Enclave Parkway #2710
  289.         Houston, TX  77077
  290.  
  291.     Internet address:
  292.         peter@sugar.uu.net
  293.     UUCP path:
  294.         texbell!sugar!peter
  295.     Compuserve:
  296.         70216,1076
  297.  
  298. Donations:
  299.  
  300.     If you find this program useful, you may send a donation to the
  301. author, Peter da Silva. For a donation of thirty dollars or more you will
  302. receive the latest version of Browser (or, if you prefer, the next version
  303. whenever it comes out). I plan on listing donors in future versions of the
  304. manual in a "Sponsors" section. If you want your name to be used, let me
  305. know. If you don't say anything, I'll assume you want anonymity and will
  306. respect your privacy. Whatever you do I'll never sell your name to a
  307. mailing list :->.
  308.  
  309.